/*
===========================================================================
This source file is part of DyLab (Dynamic Laboratory)
For the latest info, see http://code.google.com/p/dylab/

Copyright (c) 2006-2008 Lukas Krejci
(krejci.lukas@volny.cz)

This file is part of DyLab.

    DyLab is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    DyLab is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with DyLab.  If not, see <http://www.gnu.org/licenses/>.
===========================================================================
*/

#ifndef __dylab_GfxEvent_h__
#define __dylab_GfxEvent_h__

//===========================================================================================
#include <dylab/utils/geometry/Vector3.h>

//===========================================================================================
namespace dylab {

    /** 
     * Render event data structure
     */
    class DYLAB_EXPORT GfxEvent
    {
    public:
        // all possible event types
        enum type_t {
            FRAME_RENDERED
        };

    private:
        // render event type
        type_t mType;

        // rendered frame number (from the start of the rendering)
        uint32_t mFrameNumber;

        // time elapsed from the last rendered frame (in ms)
        uint32_t mFrameDurationMS;

    public:

        /** frame rendered
         */
        GfxEvent(type_t _type, uint32_t _frameNumber, uint32_t _frameDurationMS);

        /**
        */
        virtual ~GfxEvent();

        /**
        */
        type_t getType() const;

        /**
        */
        uint32_t getFrameNumber() const;

        /**
        */
        uint32_t getFrameDurationMS() const;
    };
}
//===========================================================================================
#endif // __dylab_GfxEvent_h__
